Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

Merged
merged 35 commits into from
Nov 24, 2024
Merged

feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns #3942

merged 35 commits into from
Nov 24, 2024

Conversation

antsukanova
Copy link
Contributor

@antsukanova antsukanova commented Oct 28, 2024 •
edited
Loading

COMPLETES # SPARK-559645

This pull request addresses

Introduce SDK changes to call WCME and Locus APIs when the current user steps away or returns.

Related PRs:

  • PR-3942: Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns
  • PR-3946: Step Away feature unit tests

by making the following changes

This PR only contains updates for SDK logic for the sender mostly.
Since the PR is still under development with unit tests (https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-574651), it will be presented as a draft.
Also, for now, it will contain local linking "link:../../../../webrtc-media-core" for better dx until WCME changes will be ready and release.

Also, either this PR or a separate one will be updated logic for test-app.

How to test:

  1. Create PMR with guest join from SDK and native/web from your user.
  2. Click on the Be right back true / Be right back false buttons in "Participants, Breakout Sessions, and Events published" section. Check the console with data about Be right back requests (for example locus-info:updateSelf->event#SELF_MEETING_BRB_CHANGED)

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

  • tested flow with good/bad requests using a sample app.
  • tested flow with native / web clients and a sample app.

I certified that

  • I have read and followed contributing guidelines

  • I discussed changes with code owners prior to submitting this pull request

  • I have not skipped any automated checks

  • All existing and new tests passed

  • I have updated the documentation accordingly

Make sure to have followed the contributing guidelines before submitting.

@antsukanova antsukanova added the validated If the pull request is validated for automation. label Oct 28, 2024
@antsukanova antsukanova self-assigned this Oct 28, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 28, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@antsukanova antsukanova changed the base branch from next to stepAway October 31, 2024 08:57
@SomeBody16 SomeBody16 mentioned this pull request Oct 31, 2024
Merged
11 tasks
@antsukanova antsukanova marked this pull request as ready for review November 4, 2024 14:00
@antsukanova antsukanova requested review from a team as code owners November 4, 2024 14:00
SomeBody16
SomeBody16 requested changes Nov 4, 2024
View reviewed changes
Copy link
Contributor

@SomeBody16 SomeBody16 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With 2 comments

packages/@webex/plugin-meetings/src/locus-info/selfUtils.ts Outdated Show resolved Hide resolved
docs/samples/browser-plugin-meetings/app.js Outdated Show resolved Hide resolved
brycetham
brycetham reviewed Nov 4, 2024
View reviewed changes
Copy link
Contributor

@brycetham brycetham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! I left a rather lengthy comment about the timing of sending the "away" state. Ideally, we'd like to send the "away" state as soon as possible, and with how it is right now, I suspect we'd see a noticeable delay.

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved
packages/@webex/plugin-meetings/src/meeting/index.ts Show resolved Hide resolved
packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved
brycetham
brycetham reviewed Nov 6, 2024
View reviewed changes
Copy link
Contributor

@brycetham brycetham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with Marcin about checking transcoded meetings, though we don't have to do it in this PR (as long as you stick a TODO in there). Left a small question about the event we're emitting but other than that looks good.

packages/@webex/plugin-meetings/src/meeting/index.ts Outdated Show resolved Hide resolved
@SomeBody16 SomeBody16 deleted the branch webex:brb-feature November 7, 2024 10:52
@SomeBody16 SomeBody16 closed this Nov 7, 2024
@SomeBody16 SomeBody16 reopened this Nov 7, 2024
@antsukanova antsukanova force-pushed the antsukan/SPARK-559645 branch 2 times, most recently from 471268c to ce7757f Compare November 18, 2024 18:37
@antsukanova antsukanova changed the base branch from stepAway to next November 18, 2024 18:43
@antsukanova antsukanova changed the base branch from next to stepAway November 18, 2024 18:43
@antsukanova antsukanova changed the base branch from stepAway to stepAway-test November 18, 2024 18:45
@antsukanova antsukanova deleted the branch webex:brb-feature November 18, 2024 19:02
@antsukanova antsukanova reopened this Nov 18, 2024
@antsukanova antsukanova changed the base branch from stepAway-test to stepAway November 18, 2024 19:07
@antsukanova antsukanova changed the base branch from stepAway to brb-feature November 18, 2024 19:07
brycetham
brycetham approved these changes Nov 21, 2024
View reviewed changes
Copy link
Contributor

@brycetham brycetham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Left a super minor comment and a small question, but none of them are blocking are I've approved it.

packages/@webex/plugin-meetings/src/meeting/index.ts Show resolved Hide resolved
packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js Show resolved Hide resolved
@antsukanova antsukanova merged commit 2ff58a4 into webex:brb-feature Nov 24, 2024
11 checks passed
@antsukanova antsukanova deleted the antsukan/SPARK-559645 branch November 24, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcin-bazyl marcin-bazyl marcin-bazyl left review comments

@SomeBody16 SomeBody16 SomeBody16 approved these changes

@brycetham brycetham brycetham approved these changes

@szotrabh szotrabh Awaiting requested review from szotrabh

@k-wasniowski k-wasniowski Awaiting requested review from k-wasniowski

@edvujic edvujic Awaiting requested review from edvujic

Assignees

@SomeBody16 SomeBody16

@antsukanova antsukanova

Labels
validated If the pull request is validated for automation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@antsukanova @marcin-bazyl @brycetham @SomeBody16 @edvujic @fnowakow